home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 2003 August / MW 8 2003 CD1.iso / Inside Macworld / Product News / gimp-1.2.4.sit / gimp-1.2.4 / devel-docs / libgimp / sgml / gimpplugin.sgml < prev    next >
Encoding:
Text File  |  2003-05-20  |  6.3 KB  |  167 lines
  1. <refentry id="libgimp-gimpplugin" revision="19 Jan 2001">
  2. <refmeta>
  3. <refentrytitle>gimpplugin</refentrytitle>
  4. <manvolnum>3</manvolnum>
  5. <refmiscinfo>LIBGIMP Library</refmiscinfo>
  6. </refmeta>
  7.  
  8. <refnamediv>
  9. <refname>gimpplugin</refname><refpurpose></refpurpose>
  10. </refnamediv>
  11.  
  12. <refsynopsisdiv><title>Synopsis</title>
  13. <synopsis>
  14.  
  15.  
  16.  
  17. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-progress-init">gimp_progress_init</link>              (<link linkend="gchar">gchar</link> *message);
  18. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-progress-update">gimp_progress_update</link>            (<link linkend="gdouble">gdouble</link> percentage);
  19. <link linkend="gchar">gchar</link>*      <link linkend="gimp-temp-PDB-name">gimp_temp_PDB_name</link>              (void);
  20. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-domain-register">gimp_plugin_domain_register</link>     (<link linkend="gchar">gchar</link> *domain_name,
  21.                                              <link linkend="gchar">gchar</link> *domain_path);
  22. <link linkend="gboolean">gboolean</link>    <link linkend="gimp-plugin-help-register">gimp_plugin_help_register</link>       (<link linkend="gchar">gchar</link> *help_path);
  23. </synopsis>
  24. </refsynopsisdiv>
  25.  
  26.  
  27.  
  28.  
  29.  
  30. <refsect1>
  31. <title>Description</title>
  32. <para>
  33.  
  34. </para>
  35. </refsect1>
  36.  
  37. <refsect1>
  38. <title>Details</title>
  39. <refsect2>
  40. <title><anchor id="gimp-progress-init">gimp_progress_init ()</title>
  41. <programlisting><link linkend="gboolean">gboolean</link>    gimp_progress_init              (<link linkend="gchar">gchar</link> *message);</programlisting>
  42. <para>
  43. Initializes the progress bar for the current plug-in.
  44. </para>
  45. <para>
  46. Initializes the progress bar for the current plug-in. It is only
  47. valid to call this procedure from a plug-in.</para>
  48. <para>
  49.  
  50. </para><informaltable pgwide=1 frame="none" role="params">
  51. <tgroup cols="2">
  52. <colspec colwidth="2*">
  53. <colspec colwidth="8*">
  54. <tbody>
  55. <row><entry align="right"><parameter>message</parameter> :</entry>
  56. <entry> Message to use in the progress dialog.
  57. </entry></row>
  58. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  59. </entry></row>
  60. </tbody></tgroup></informaltable></refsect2>
  61. <refsect2>
  62. <title><anchor id="gimp-progress-update">gimp_progress_update ()</title>
  63. <programlisting><link linkend="gboolean">gboolean</link>    gimp_progress_update            (<link linkend="gdouble">gdouble</link> percentage);</programlisting>
  64. <para>
  65. Updates the progress bar for the current plug-in.
  66. </para>
  67. <para>
  68. Updates the progress bar for the current plug-in. It is only valid
  69. to call this procedure from a plug-in.</para>
  70. <para>
  71.  
  72. </para><informaltable pgwide=1 frame="none" role="params">
  73. <tgroup cols="2">
  74. <colspec colwidth="2*">
  75. <colspec colwidth="8*">
  76. <tbody>
  77. <row><entry align="right"><parameter>percentage</parameter> :</entry>
  78. <entry> Percentage of progress completed.
  79. </entry></row>
  80. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  81. </entry></row>
  82. </tbody></tgroup></informaltable></refsect2>
  83. <refsect2>
  84. <title><anchor id="gimp-temp-PDB-name">gimp_temp_PDB_name ()</title>
  85. <programlisting><link linkend="gchar">gchar</link>*      gimp_temp_PDB_name              (void);</programlisting>
  86. <para>
  87. Generates a unique temporary PDB name.
  88. </para>
  89. <para>
  90. This procedure generates a temporary PDB entry name that is
  91. guaranteed to be unique. It is many used by the interactive popup
  92. dialogs to generate a PDB entry name.</para>
  93. <para>
  94.  
  95. </para><informaltable pgwide=1 frame="none" role="params">
  96. <tgroup cols="2">
  97. <colspec colwidth="2*">
  98. <colspec colwidth="8*">
  99. <tbody>
  100. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> A unique temporary name for a temporary PDB entry.
  101. </entry></row>
  102. </tbody></tgroup></informaltable></refsect2>
  103. <refsect2>
  104. <title><anchor id="gimp-plugin-domain-register">gimp_plugin_domain_register ()</title>
  105. <programlisting><link linkend="gboolean">gboolean</link>    gimp_plugin_domain_register     (<link linkend="gchar">gchar</link> *domain_name,
  106.                                              <link linkend="gchar">gchar</link> *domain_path);</programlisting>
  107. <para>
  108. Registers a textdomain for localisation.
  109. </para>
  110. <para>
  111. This procedure adds a textdomain to the list of domains Gimp
  112. searches for strings when translating its menu entries. There is no
  113. need to call this function for plug-ins that have their strings
  114. included in the gimp-std-plugins domain as that is used by default.
  115. If the compiled message catalog is not in the standard location, you
  116. may specify an absolute path to another location. This procedure can
  117. only be called in the query function of a plug-in and it has to be
  118. called before any procedure is installed.</para>
  119. <para>
  120.  
  121. </para><informaltable pgwide=1 frame="none" role="params">
  122. <tgroup cols="2">
  123. <colspec colwidth="2*">
  124. <colspec colwidth="8*">
  125. <tbody>
  126. <row><entry align="right"><parameter>domain_name</parameter> :</entry>
  127. <entry> The name of the textdomain (must be unique).
  128. </entry></row>
  129. <row><entry align="right"><parameter>domain_path</parameter> :</entry>
  130. <entry> The absolute path to the compiled message catalog (may be NULL).
  131. </entry></row>
  132. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  133. </entry></row>
  134. </tbody></tgroup></informaltable></refsect2>
  135. <refsect2>
  136. <title><anchor id="gimp-plugin-help-register">gimp_plugin_help_register ()</title>
  137. <programlisting><link linkend="gboolean">gboolean</link>    gimp_plugin_help_register       (<link linkend="gchar">gchar</link> *help_path);</programlisting>
  138. <para>
  139. Register a help path for a plug-in.
  140. </para>
  141. <para>
  142. This procedure changes the help rootdir for the plug-in which calls
  143. it. All subsequent calls of gimp_help from this plug-in will be
  144. interpreted relative to this rootdir. This procedure can only be
  145. called in the query function of a plug-in and it has to be called
  146. before any procedure is installed.</para>
  147. <para>
  148.  
  149. </para><informaltable pgwide=1 frame="none" role="params">
  150. <tgroup cols="2">
  151. <colspec colwidth="2*">
  152. <colspec colwidth="8*">
  153. <tbody>
  154. <row><entry align="right"><parameter>help_path</parameter> :</entry>
  155. <entry> The rootdir of the plug-in's help pages.
  156. </entry></row>
  157. <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
  158. </entry></row>
  159. </tbody></tgroup></informaltable></refsect2>
  160.  
  161. </refsect1>
  162.  
  163.  
  164.  
  165.  
  166. </refentry>
  167.